// --------------------------------------------------------------------------------------------------------------------
// <copyright file="IURControlClientNetworkConnection.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace Microsoft.Robotics.Hardware.UniversalRobots
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using System.Net;
    using System.Net.Sockets;
    using System.Text;
    using System.Threading.Tasks;

    /// <summary>
    /// Interface for network connection to URControl server.
    /// </summary>
    public interface IURControlClientNetworkConnection : IDisposable
    {
        /// <summary>
        /// Gets a value indicating whether a connection is currently established to the URControl server.
        /// </summary>
        bool Connected { get; }

        /// <summary>
        /// Connect asynchronously to URControl server.
        /// </summary>
        /// <param name="hostName">The hostname.</param>
        /// <param name="port">Port number.</param>
        /// <returns>A task.</returns>
        Task ConnectAsync(string hostName, int port);

        /// <summary>
        /// Get stream for reading and writing to URControl server.
        /// </summary>
        /// <returns>A network stream for reading and writing to URControl server.</returns>
        Stream GetStream();

        /// <summary>
        /// Close the network connection.
        /// </summary>
        void Close();
    }
}
